/*
 * Copyright (C) 2009-2011 Knowings
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License version 3
 * as published by the Free Software Foundation.
 *

 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.

 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 */
package com.knowings.tbs.trace;

import java.util.List;

/**
 * Interface describing an Observed Element.
 * 
 * @author privarola
 */
public interface IObsel extends ITraceElement {

  /**
   * Method returning the start date of this observed element.
   * @return the start date of this observed element
   */
  public long getStartDate();

  /**
   * Method returning the end date of this observed element.
   * @return the end date of this observed element
   */
  public long getEndDate();

  /**
   * Method returning the reference to the bearing trace.
   * @return the bearing trace instance
   */
  public ITrace getTrace();

  /**
   * Method returning all relations starting from this observed element
   * @return all relations starting from this observed element
   */
  public List<IRelation> getFromRelations();

  /**
   * Method returning all relations ending to this observed element
   * @return all relations ending to this observed element
   */
  public List<IRelation> getToRelations();

  /**
   * Convenience method returning all obseved elements in relation with this one
   * @return all the observed elements that are in relation with this one
   */
  public List<IObsel> getRelatedObsels();
}
